home *** CD-ROM | disk | FTP | other *** search
/ The 640 MEG Shareware Studio 2 / The 640 Meg Shareware Studio CD-ROM Volume II (Data Express)(1993).ISO / bbs / ustatv30.zip / USERSTAT.DOC < prev    next >
Text File  |  1992-09-01  |  7KB  |  162 lines
  1.              USERSTAT - The user statistics program
  2.                     
  3.                       ver 3.0 documentation
  4.                              
  5.                              
  6. Legal Shit:  Please don't distribute changed versions.  I am not
  7. responsible if this software eats your hard drive.  I am not liable
  8. for any damages or loss of time if this software does not perform as
  9. expected. I make no guarantees as to the suitability of this software
  10. for any purpose, not even that for which it was designed.
  11.  
  12. THIS IS NOT FREEWARE or PUBLIC DOMAIN SOFTWARE.  You may use this
  13. software on your BBS for a period of 30 days.  At the end of this
  14. time period, you must remove the software & the generated GFILES or
  15. send in your registration fee.  Please note however, this is the
  16. full-featured version of the software, it is not crippled in any way,
  17. (at least not intentionally <grin>) as I trust WWIV sysops out there
  18. to do the right thing.  And for gosh sakes, if you are running a WWIV
  19. BBS, register it!
  20.  
  21. Compatibilty:  This software has been run under MS-DOS 3.2 on an
  22. Compaq Deskpro and a Cheap Noname tawainese clone.  It has run on a
  23. IBM PS/2 models 25 and 30 under PC-DOS 3.3 and Novell Netware v2.0b.
  24. It has also run on an Original IBM AT running MS-DOS 5.0, and a DFI
  25. 486/33 running MS-DOS 5.0 and Novell Netware v2.2.  It is designed to
  26. work with any version of WWIV v4.20 and up.
  27.  
  28.                      What does USERSTAT do?
  29.  
  30. USERSTAT will compile information about the active users of your BBS
  31. and display that information in one of two ways.  The first way is to
  32. print a list of the top and bottom active users.  The "rating" of
  33. each active user is calculated by one of three different formulas.
  34.  
  35. 1. 'Formula' Ratio   = [Upload K + (# of Posts * Post Value)] /
  36. Download K
  37.  
  38. I particularly like this one because it is sort of an overall rating,
  39. a side effect of this formula is that because the number of logons
  40. does not effect the ratio, users who have been calling longer will
  41. have more posts, and therefore they'll have a higher ratio.  So it
  42. rewards longevity as well.  The Post Value can be set at run time
  43. with the /k option.  If you wanted to really reward posting, you
  44. could run USERSTAT with /k100.  This would treat each post as if the
  45. user had uploaded a 100k file.  By default, the post value is set to
  46. 10K.
  47.  
  48. 2. Up/Download Ratio = Upload K / Download K
  49.  
  50. This is very straight forward. The ratio is the same number that WWIV
  51. prints out when you press "Y" from the Transfer menu.
  52.  
  53. 3. Post/Logon Ratio  = # of Posts / # of Logons
  54.  
  55. This is also very straight forward.
  56.  
  57. These text files can then be viewed by your users in the GFILES area.
  58.  
  59.                     Installing USERSTAT
  60.                     
  61. Before you run USERSTAT for the first time, you must create a GFILE
  62. area for it with GFILEEDIT or press G at WFC.  Name the area
  63. something like User Statistics, and make the directory name USERSTAT.
  64.  
  65. When you are done, the screen should look like this:
  66.  
  67. <insert GFILEEDIT screen here>
  68.  
  69. Now, either shell to DOS or quit the BBS.
  70.  
  71. You should place the USERSTAT.EXE file in your main BBS directory, as
  72. it needs to be there in order to find the CONFIG.DAT file.  This is
  73. the only file that needs to be the main directory.
  74.  
  75. Now, run USERSTAT as many times as is necessary to create the files
  76. you want. (ie, once for plain output, once for ansi output, once for
  77. ansi output of a table of all users, once for plain output of a table
  78. of all users) On my system I use:
  79.  
  80. USERSTAT /f /u /p /s       [Plain output of each formula top & bottom users]
  81. USERSTAT /f /u /p /s /a    [ANSI output of each formula top & bottom users]
  82. USERSTAT /f /u /p /s /t    [Plain output of a table of each user - all formulas]
  83. USERSTAT /f /u /p /s /t /a [ANSI output of a table of each user-all formulas]
  84.  
  85. You might need to add /l1 to reduce the required number of logons
  86. required to be viewed as an active user.
  87.  
  88. Now, get back into the BBS (I know, this is a pain in the A$$, in
  89. future versions, USERSTAT will automatically create the entry for you)
  90.  
  91. Now go into the GFILE section you created earlier (press G from the
  92. Main Menu, *NOT* from WFC or //GFILEEDIT) and use A to add the files
  93. to the list.
  94.  
  95. The first two letters of the file name shows the formula the file contains:
  96.  
  97. FM  - Overall Ratio ('Formula')
  98. UD  - Up/Download Ratio
  99. PL  - Post to Logon Ratio
  100.  
  101. The next 5 letters are either RATIO or TABLE.
  102.  
  103. RATIO is the top and bottom user list.
  104. TABLE is a list of all users.
  105.  
  106. and then the file extension is either .ANS or .MSG
  107.  
  108. .MSG files are plain output (no ANSI characters)
  109. .ANS files have ANSI codes in them.
  110.  
  111. Great!  Now, you'll have to create/modify a batch file in order to
  112. automatically update the GFILES on a nightly basis.  See the WWIV
  113. documentation to figure this out.
  114.  
  115. Appendix A:
  116.  
  117. The command line options for USERSTAT are as follows:
  118.  
  119. /s      Don't count sysop in calculations 
  120. /u      Generate Upload/Download List 
  121. /p      Generate Post/Logon List 
  122. /f      Generate Formula ratio list (my personal favorite) 
  123. /lxx    Don't count users with less than xx logons 
  124. /kxx    Count each post as xx K bytes worth of uploads in the Formula List 
  125. /d      Display Dedication line, and my BBS phone number.  
  126. /?      Display a small help screen..  
  127. /a      Generate ANSI messages... (end in .ANS instead of .MSG) 
  128. /nxx    Print Best & Worst xx users for each group. 1 <= xx <= 99
  129. /t      Generate tables of ALL users instead. (/l option still applys)
  130.                                               (/n option does NOT)
  131.                                               
  132. Appendix B:
  133.  
  134. In the past there has been some confusion as to what exactly USERSTAT
  135. considers as an active user.  Well, the criteria are different for
  136. the Post/Logon formula then for the Up/Download or Overall ratios.
  137.  
  138. First, USERSTAT checks the number of logons, if a user logged on at
  139. least the specified number of logons, he is not considered active.
  140.  
  141. Second, if the /s option was used, anyone with a SL of 100 or greater
  142. is excluded from the list.
  143.  
  144. Third, if we are generating a Up/Download or Overall list, the user
  145. must have downloaded at least 1k or uploaded more than 200k.
  146.  
  147. That's it.
  148.  
  149. If you have any suggestions, tips, desires, problems, please contact me.
  150.  
  151. And please, register this software!
  152.  
  153. Marc A. Runkel
  154.  
  155. 502@1 (WWIVnet) or procha@titan.ucs.umass.edu (InterNet)
  156.  
  157. You can contact me at my BBS:
  158.  
  159. Fred's Floating Bar and Grill (413) 586-2099 1200/2400/9600/14.4k
  160. US Robotics Dual Standard Modem                  NO RATIOS! EVER!
  161.  
  162. Peace.